/*
 * ============================================================================
 *                   GNU Lesser General Public License
 * ============================================================================
 *
 *
 *
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307, USA.
 * 
 *
 *
 */
package rad.framework.security.jpa;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * Use the annotation to define permissions on entity beans.
 * 
 * Example:
 * 
 * <pre>
 *    PrincipalsAllowed(actions = {Action.ALL}, roles = { &quot;Admin&quot; }, principalExpressions = { &quot;customer.name&quot; })
 * </pre>
 * 
 * @author boudyacho
 * 
 */
@Target(TYPE)
@Retention(RUNTIME)
@Documented
public @interface PrincipalsAllowed {

	/**
	 * Actions being granted.
	 * 
	 * @return
	 */
	Action[] actions() default Action.ALL;

	/**
	 * JAAS Roles granted the actions.
	 * 
	 * @return
	 */
	String[] roles() default {};

	/**
	 * EL expressions that point to properties containing user names that
	 * are granted the actions.
	 * 
	 * @return
	 */
	String[] userExpressions() default {};

	/**
	 * EL expressions that point to properties containing role names that
	 * are granted the actions.
	 * 
	 * @return
	 */
	String[] roleExpressions() default {};

}
